<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WB32L003 Standard Peripherals Firmware Library: BEEP</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">WB32L003 Standard Peripherals Firmware Library
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#groups">Modules</a> &#124;
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">BEEP<div class="ingroups"><a class="el" href="group___w_b32_l003___std_periph___driver.html">WB32L003_StdPeriph_Driver</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>BEEP driver modules.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group___b_e_e_p___exported___constants"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_e_e_p___exported___constants.html">BEEP_Exported_Constants</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group___b_e_e_p___private___functions"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_e_e_p___private___functions.html">BEEP_Private_Functions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_b_e_e_p___init_type_def.html">BEEP_InitTypeDef</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">BEEP Init structure definition.  <a href="struct_b_e_e_p___init_type_def.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga689e7224b686c1dedef4cb36ab3017f6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><b>IS_BEEP_CLK_SEL</b>(SEL)</td></tr>
<tr class="separator:ga689e7224b686c1dedef4cb36ab3017f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab0d45559070e872654e90c3cf0493306"><td class="memItemLeft" align="right" valign="top"><a id="gab0d45559070e872654e90c3cf0493306"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>IS_BEEP_PRESCALER</b>(PRESCALER)&#160;&#160;&#160;((PRESCALER) &lt; 4096)</td></tr>
<tr class="separator:gab0d45559070e872654e90c3cf0493306"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacf615ce33b987bb7bde3da0a9fb8fef1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><b>IS_BEEP_OUT_DIV</b>(DIV)</td></tr>
<tr class="separator:gacf615ce33b987bb7bde3da0a9fb8fef1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga6569658548e8bc3306d2bcc8c2b00b80"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_e_e_p.html#ga6569658548e8bc3306d2bcc8c2b00b80">BEEP_DeInit</a> (<a class="el" href="struct_b_e_e_p___type_def.html">BEEP_TypeDef</a> *BEEPx)</td></tr>
<tr class="memdesc:ga6569658548e8bc3306d2bcc8c2b00b80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deinitializes the BEEP peripheral registers to their default reset values.  <a href="#ga6569658548e8bc3306d2bcc8c2b00b80">More...</a><br /></td></tr>
<tr class="separator:ga6569658548e8bc3306d2bcc8c2b00b80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga96ad3fb19b4b28913b365083ccf49a5e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_e_e_p.html#ga96ad3fb19b4b28913b365083ccf49a5e">BEEP_Init</a> (<a class="el" href="struct_b_e_e_p___type_def.html">BEEP_TypeDef</a> *BEEPx, <a class="el" href="struct_b_e_e_p___init_type_def.html">BEEP_InitTypeDef</a> *BEEP_InitStruct)</td></tr>
<tr class="memdesc:ga96ad3fb19b4b28913b365083ccf49a5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the BEEP peripheral according to the specified parameters in the BEEP_InitStruct.  <a href="#ga96ad3fb19b4b28913b365083ccf49a5e">More...</a><br /></td></tr>
<tr class="separator:ga96ad3fb19b4b28913b365083ccf49a5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga33ffbae00b8a4a6d1b7658916f5d31de"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_e_e_p.html#ga33ffbae00b8a4a6d1b7658916f5d31de">BEEP_Cmd</a> (<a class="el" href="struct_b_e_e_p___type_def.html">BEEP_TypeDef</a> *BEEPx, FunctionalState NewState)</td></tr>
<tr class="memdesc:ga33ffbae00b8a4a6d1b7658916f5d31de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables BEEP peripheral.  <a href="#ga33ffbae00b8a4a6d1b7658916f5d31de">More...</a><br /></td></tr>
<tr class="separator:ga33ffbae00b8a4a6d1b7658916f5d31de"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>BEEP driver modules. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga689e7224b686c1dedef4cb36ab3017f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga689e7224b686c1dedef4cb36ab3017f6">&#9670;&nbsp;</a></span>IS_BEEP_CLK_SEL</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define IS_BEEP_CLK_SEL</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">SEL</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">(((SEL) == BEEP_ClkSel_STOP) || \</div><div class="line">                              ((SEL) == BEEP_ClkSel_LSI) || \</div><div class="line">                              ((SEL) == BEEP_ClkSel_HSE) || \</div><div class="line">                              ((SEL) == BEEP_ClkSel_PCLK))</div></div><!-- fragment -->
</div>
</div>
<a id="gacf615ce33b987bb7bde3da0a9fb8fef1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacf615ce33b987bb7bde3da0a9fb8fef1">&#9670;&nbsp;</a></span>IS_BEEP_OUT_DIV</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define IS_BEEP_OUT_DIV</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">DIV</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">(((DIV) == BEEP_OutDiv2) || \</div><div class="line">                              ((DIV) == BEEP_OutDiv4) || \</div><div class="line">                              ((DIV) == BEEP_OutDiv8))</div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga33ffbae00b8a4a6d1b7658916f5d31de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga33ffbae00b8a4a6d1b7658916f5d31de">&#9670;&nbsp;</a></span>BEEP_Cmd()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void BEEP_Cmd </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_b_e_e_p___type_def.html">BEEP_TypeDef</a> *&#160;</td>
          <td class="paramname"><em>BEEPx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">FunctionalState&#160;</td>
          <td class="paramname"><em>NewState</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables or disables BEEP peripheral. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BEEPx</td><td>Pointer to selected BEEP peripheral. This parameter can be one of the following values: BEEP. </td></tr>
    <tr><td class="paramname">NewState</td><td>The new state of the BEEP peripheral. This parameter can be: ENABLE or DISABLE. </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">None</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga6569658548e8bc3306d2bcc8c2b00b80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6569658548e8bc3306d2bcc8c2b00b80">&#9670;&nbsp;</a></span>BEEP_DeInit()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void BEEP_DeInit </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_b_e_e_p___type_def.html">BEEP_TypeDef</a> *&#160;</td>
          <td class="paramname"><em>BEEPx</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Deinitializes the BEEP peripheral registers to their default reset values. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BEEPx</td><td>Pointer to selected BEEP peripheral. This parameter can be one of the following values: BEEP. </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">None</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga96ad3fb19b4b28913b365083ccf49a5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga96ad3fb19b4b28913b365083ccf49a5e">&#9670;&nbsp;</a></span>BEEP_Init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void BEEP_Init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_b_e_e_p___type_def.html">BEEP_TypeDef</a> *&#160;</td>
          <td class="paramname"><em>BEEPx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_b_e_e_p___init_type_def.html">BEEP_InitTypeDef</a> *&#160;</td>
          <td class="paramname"><em>BEEP_InitStruct</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initializes the BEEP peripheral according to the specified parameters in the BEEP_InitStruct. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BEEPx</td><td>Pointer to selected BEEP peripheral. This parameter can be one of the following values: BEEP. </td></tr>
    <tr><td class="paramname">BEEP_InitStruct</td><td>Pointer to BEEP initialization struct </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">None</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by Westberry Technology (ChangZhou) Corp., Ltd. All rights reserved.
</small></address>
</body>
</html>
